<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Kyoto Cabinet: kyotocabinet::LZMA Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Kyoto Cabinet
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>      </li>
      <li class="navelem"><a class="el" href="classkyotocabinet_1_1LZMA.html">LZMA</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">kyotocabinet::LZMA Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="kyotocabinet::LZMA" -->
<p><a class="el" href="classkyotocabinet_1_1LZMA.html" title="LZMA compressor.">LZMA</a> compressor.  
 <a href="classkyotocabinet_1_1LZMA.html#details">More...</a></p>

<p><code>#include &lt;kccompress.h&gt;</code></p>

<p><a href="classkyotocabinet_1_1LZMA-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">Mode</a> { <a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6">RAW</a>, 
<a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6ad0beb5e249e1f0847361f437df116537">CRC</a>, 
<a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6a204c45cb48186348af9242ca3044bb39">SHA</a>
 }</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression modes.  <a href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1LZMA.html#aa4681b53b64f5869212d1b94282bc20e">compress</a> (const void *buf, size_t size, size_t *sp, <a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">Mode</a> mode=<a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6">RAW</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Compress a serial data.  <a href="#aa4681b53b64f5869212d1b94282bc20e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1LZMA.html#a6a59c4a85d2ed31a649346c14b28cc0f">decompress</a> (const void *buf, size_t size, size_t *sp, <a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">Mode</a> mode=<a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6">RAW</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Decompress a serial data.  <a href="#a6a59c4a85d2ed31a649346c14b28cc0f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1LZMA.html#a656dc966cebb0c64b2943c9f45cf4475">calculate_crc</a> (const void *buf, size_t size, uint32_t seed=0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the CRC32 checksum of a serial data.  <a href="#a656dc966cebb0c64b2943c9f45cf4475"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classkyotocabinet_1_1LZMA.html" title="LZMA compressor.">LZMA</a> compressor. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a6a2ab2e2c4a0ae133e09bb83788c85a6"></a><!-- doxytag: member="kyotocabinet::LZMA::Mode" ref="a6a2ab2e2c4a0ae133e09bb83788c85a6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">kyotocabinet::LZMA::Mode</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Compression modes. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6"></a><!-- doxytag: member="RAW" ref="a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6" args="" -->RAW</em>&nbsp;</td><td>
<p>without any checksum </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a6a2ab2e2c4a0ae133e09bb83788c85a6ad0beb5e249e1f0847361f437df116537"></a><!-- doxytag: member="CRC" ref="a6a2ab2e2c4a0ae133e09bb83788c85a6ad0beb5e249e1f0847361f437df116537" args="" -->CRC</em>&nbsp;</td><td>
<p>with CRC32 checksum </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a6a2ab2e2c4a0ae133e09bb83788c85a6a204c45cb48186348af9242ca3044bb39"></a><!-- doxytag: member="SHA" ref="a6a2ab2e2c4a0ae133e09bb83788c85a6a204c45cb48186348af9242ca3044bb39" args="" -->SHA</em>&nbsp;</td><td>
<p>with SHA256 checksum </p>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa4681b53b64f5869212d1b94282bc20e"></a><!-- doxytag: member="kyotocabinet::LZMA::compress" ref="aa4681b53b64f5869212d1b94282bc20e" args="(const void *buf, size_t size, size_t *sp, Mode mode=RAW)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static char* <a class="el" href="classkyotocabinet_1_1LZMA.html#aa4681b53b64f5869212d1b94282bc20e">kyotocabinet::LZMA::compress</a> </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>sp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">Mode</a>&#160;</td>
          <td class="paramname"><em>mode</em> = <code><a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6">RAW</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Compress a serial data. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>the input buffer. </td></tr>
    <tr><td class="paramname">size</td><td>the size of the input buffer. </td></tr>
    <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
    <tr><td class="paramname">mode</td><td>the compression mode. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the result data, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Because the region of the return value is allocated with the the new[] operator, it should be released with the delete[] operator when it is no longer in use. </dd></dl>

</div>
</div>
<a class="anchor" id="a6a59c4a85d2ed31a649346c14b28cc0f"></a><!-- doxytag: member="kyotocabinet::LZMA::decompress" ref="a6a59c4a85d2ed31a649346c14b28cc0f" args="(const void *buf, size_t size, size_t *sp, Mode mode=RAW)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static char* <a class="el" href="classkyotocabinet_1_1LZMA.html#a6a59c4a85d2ed31a649346c14b28cc0f">kyotocabinet::LZMA::decompress</a> </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *&#160;</td>
          <td class="paramname"><em>sp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6">Mode</a>&#160;</td>
          <td class="paramname"><em>mode</em> = <code><a class="el" href="classkyotocabinet_1_1LZMA.html#a6a2ab2e2c4a0ae133e09bb83788c85a6a0c45976407c875ead1fb929bc44fd4b6">RAW</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Decompress a serial data. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>the input buffer. </td></tr>
    <tr><td class="paramname">size</td><td>the size of the input buffer. </td></tr>
    <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
    <tr><td class="paramname">mode</td><td>the compression mode. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the result data, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Because an additional zero code is appended at the end of the region of the return value, the return value can be treated as a C-style string. Because the region of the return value is allocated with the the new[] operator, it should be released with the delete[] operator when it is no longer in use. </dd></dl>

</div>
</div>
<a class="anchor" id="a656dc966cebb0c64b2943c9f45cf4475"></a><!-- doxytag: member="kyotocabinet::LZMA::calculate_crc" ref="a656dc966cebb0c64b2943c9f45cf4475" args="(const void *buf, size_t size, uint32_t seed=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static uint32_t <a class="el" href="classkyotocabinet_1_1LZMA.html#a656dc966cebb0c64b2943c9f45cf4475">kyotocabinet::LZMA::calculate_crc</a> </td>
          <td>(</td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>seed</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Calculate the CRC32 checksum of a serial data. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>the input buffer. </td></tr>
    <tr><td class="paramname">size</td><td>the size of the input buffer. </td></tr>
    <tr><td class="paramname">seed</td><td>the cyclic seed value. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the CRC32 checksum. </dd></dl>

</div>
</div>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
